<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Algorithm/IpMuOracle.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('IpMuOracle_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">IpMuOracle.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="IpMuOracle_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (C) 2004, 2007 International Business Machines and others.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">//</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef __IPMUORACLE_HPP__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define __IPMUORACLE_HPP__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span> </div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html">   19</a></span><span class="keyword">class </span><a class="code hl_class" href="classIpopt_1_1MuOracle.html">MuOracle</a>: <span class="keyword">public</span> <a class="code hl_class" href="classIpopt_1_1AlgorithmStrategyObject.html">AlgorithmStrategyObject</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>{</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html#a4ec47ded0c3202eebd588873d4f6dedc">   25</a></span>   <a class="code hl_function" href="classIpopt_1_1MuOracle.html#a4ec47ded0c3202eebd588873d4f6dedc">MuOracle</a>()</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>   { }</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html#a37c20711d7b3e426aa5c782dd45716ef">   29</a></span>   <span class="keyword">virtual</span> <a class="code hl_function" href="classIpopt_1_1MuOracle.html#a37c20711d7b3e426aa5c782dd45716ef">~MuOracle</a>()</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>   { }</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html#a046083be909dc54e3468484fd35301a0">   33</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1MuOracle.html#a046083be909dc54e3468484fd35301a0">InitializeImpl</a>(</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1OptionsList.html">OptionsList</a>&amp; options,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>      <span class="keyword">const</span> std::string&amp; prefix</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>   ) = 0;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html#ab65beebf749a613c04aa49683905b433">   48</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1MuOracle.html#ab65beebf749a613c04aa49683905b433">CalculateMu</a>(</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>      <a class="code hl_typedef" href="namespaceIpopt.html#ab75ce5f2ad60aa86e4dff723998e653f">Number</a>  mu_min,</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>      <a class="code hl_typedef" href="namespaceIpopt.html#ab75ce5f2ad60aa86e4dff723998e653f">Number</a>  mu_max,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>      <a class="code hl_typedef" href="namespaceIpopt.html#ab75ce5f2ad60aa86e4dff723998e653f">Number</a>&amp; new_mu</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>   ) = 0;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html#a89a115e07d41cc980890fd230b017e85">   66</a></span>   <a class="code hl_function" href="classIpopt_1_1MuOracle.html#a89a115e07d41cc980890fd230b017e85">MuOracle</a>(</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1MuOracle.html">MuOracle</a>&amp;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>   );</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classIpopt_1_1MuOracle.html#abf1513cf61b6a6c365d69d33916d188a">   70</a></span>   <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1MuOracle.html#abf1513cf61b6a6c365d69d33916d188a">operator=</a>(</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1MuOracle.html">MuOracle</a>&amp;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>   );</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>};</div>
</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>} <span class="comment">// namespace Ipopt</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aIpAlgStrategy_8hpp_html"><div class="ttname"><a href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1AlgorithmStrategyObject_html"><div class="ttname"><a href="classIpopt_1_1AlgorithmStrategyObject.html">Ipopt::AlgorithmStrategyObject</a></div><div class="ttdoc">This is the base class for all algorithm strategy objects.</div><div class="ttdef"><b>Definition</b> <a href="IpAlgStrategy_8hpp_source.html#l00034">IpAlgStrategy.hpp:35</a></div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html"><div class="ttname"><a href="classIpopt_1_1MuOracle.html">Ipopt::MuOracle</a></div><div class="ttdoc">Abstract Base Class for classes that are able to compute a suggested value of the barrier parameter t...</div><div class="ttdef"><b>Definition</b> <a href="IpMuOracle_8hpp_source.html#l00019">IpMuOracle.hpp:20</a></div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html_a046083be909dc54e3468484fd35301a0"><div class="ttname"><a href="classIpopt_1_1MuOracle.html#a046083be909dc54e3468484fd35301a0">Ipopt::MuOracle::InitializeImpl</a></div><div class="ttdeci">virtual bool InitializeImpl(const OptionsList &amp;options, const std::string &amp;prefix)=0</div><div class="ttdoc">Implementation of the initialization method that has to be overloaded by for each derived class.</div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html_a37c20711d7b3e426aa5c782dd45716ef"><div class="ttname"><a href="classIpopt_1_1MuOracle.html#a37c20711d7b3e426aa5c782dd45716ef">Ipopt::MuOracle::~MuOracle</a></div><div class="ttdeci">virtual ~MuOracle()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> <a href="IpMuOracle_8hpp_source.html#l00029">IpMuOracle.hpp:29</a></div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html_a4ec47ded0c3202eebd588873d4f6dedc"><div class="ttname"><a href="classIpopt_1_1MuOracle.html#a4ec47ded0c3202eebd588873d4f6dedc">Ipopt::MuOracle::MuOracle</a></div><div class="ttdeci">MuOracle()</div><div class="ttdoc">Default Constructor.</div><div class="ttdef"><b>Definition</b> <a href="IpMuOracle_8hpp_source.html#l00025">IpMuOracle.hpp:25</a></div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html_a89a115e07d41cc980890fd230b017e85"><div class="ttname"><a href="classIpopt_1_1MuOracle.html#a89a115e07d41cc980890fd230b017e85">Ipopt::MuOracle::MuOracle</a></div><div class="ttdeci">MuOracle(const MuOracle &amp;)</div><div class="ttdoc">Copy Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html_ab65beebf749a613c04aa49683905b433"><div class="ttname"><a href="classIpopt_1_1MuOracle.html#ab65beebf749a613c04aa49683905b433">Ipopt::MuOracle::CalculateMu</a></div><div class="ttdeci">virtual bool CalculateMu(Number mu_min, Number mu_max, Number &amp;new_mu)=0</div><div class="ttdoc">Method for computing the value of the barrier parameter that could be used in the current iteration.</div></div>
<div class="ttc" id="aclassIpopt_1_1MuOracle_html_abf1513cf61b6a6c365d69d33916d188a"><div class="ttname"><a href="classIpopt_1_1MuOracle.html#abf1513cf61b6a6c365d69d33916d188a">Ipopt::MuOracle::operator=</a></div><div class="ttdeci">void operator=(const MuOracle &amp;)</div></div>
<div class="ttc" id="aclassIpopt_1_1OptionsList_html"><div class="ttname"><a href="classIpopt_1_1OptionsList.html">Ipopt::OptionsList</a></div><div class="ttdoc">This class stores a list of user set options.</div><div class="ttdef"><b>Definition</b> <a href="IpOptionsList_8hpp_source.html#l00032">IpOptionsList.hpp:33</a></div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
<div class="ttc" id="anamespaceIpopt_html_ab75ce5f2ad60aa86e4dff723998e653f"><div class="ttname"><a href="namespaceIpopt.html#ab75ce5f2ad60aa86e4dff723998e653f">Ipopt::Number</a></div><div class="ttdeci">ipnumber Number</div><div class="ttdoc">Type of all numbers.</div><div class="ttdef"><b>Definition</b> <a href="IpTypes_8hpp_source.html#l00017">IpTypes.hpp:17</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
